Move documentation to inline comments: GtkVBox
authorSteven Harms <sharms@ubuntu.com>
Thu, 4 Mar 2010 18:21:16 +0000 (13:21 -0500)
committerTristan Van Berkom <tristan.van.berkom@gmail.com>
Sun, 4 Apr 2010 00:59:01 +0000 (20:59 -0400)
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611831

docs/reference/gtk/tmpl/gtkvbox.sgml [deleted file]
gtk/gtkvbox.c

diff --git a/docs/reference/gtk/tmpl/gtkvbox.sgml b/docs/reference/gtk/tmpl/gtkvbox.sgml
deleted file mode 100644 (file)
index 0acfd56..0000000
+++ /dev/null
@@ -1,49 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkVBox
-
-<!-- ##### SECTION Short_Description ##### -->
-A vertical container box
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-GtkVBox is a container that organizes child widgets into a single column.
-</para>
-
-<para>
-Use the #GtkBox packing interface to determine the arrangement,
-spacing, height, and alignment of GtkVBox children.
-</para>
-
-<para>
-All children are allocated the same width.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-
-<varlistentry>
-<term>#GtkHBox</term>
-<listitem><para>a sister class that organizes widgets into a row.</para></listitem>
-</varlistentry>
-
-</variablelist>
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GtkVBox ##### -->
-
-
-
-<!-- ##### FUNCTION gtk_vbox_new ##### -->
-<para>
-Creates a new GtkVBox.
-</para>
-
-@homogeneous: %TRUE if all children are to be given equal space allotments.
-@spacing: the number of pixels to place by default between children.
-@Returns: a new GtkVBox.
-
-
index 4fcd284d6ce7288b5064538f96d7ecdcdb7f59c0..d87002699bc119c5f8a313fdffdcf1cbe9907edb 100644 (file)
 #include "gtkvbox.h"
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkvbox
+ * @Short_description: A vertical container box
+ * @Title: GtkVBox
+ * @See_also: #GtkHBox
+ *
+ * A #GtkVBox is a container that organizes child widgets into a single column.
+ *
+ * Use the #GtkBox packing interface to determine the arrangement,
+ * spacing, height, and alignment of #GtkVBox children.
+ *
+ * All children are allocated the same width.
+ */
+
 G_DEFINE_TYPE (GtkVBox, gtk_vbox, GTK_TYPE_BOX)
 
 static void
@@ -46,6 +60,15 @@ gtk_vbox_init (GtkVBox *vbox)
   _gtk_box_set_old_defaults (GTK_BOX (vbox));
 }
 
+/**
+ * gtk_vbox_new:
+ * @homogeneous: %TRUE if all children are to be given equal space allotments.
+ * @spacing: the number of pixels to place by default between children.
+ *
+ * Creates a new #GtkVBox.
+ *
+ * Returns: a new #GtkVBox.
+ */
 GtkWidget *
 gtk_vbox_new (gboolean homogeneous,
              gint     spacing)